Get Companies

The Get Companies API enables to fetch the list of added companies that helps to choose sender for a transaction.

Method: POST

{{URL}}/jsonrpc

Headers

Name	Value
Content-Type	application/json

Example

Payload Parameters

Parameter	Description
id Mandatory	String Unique ID for each request
jsonrpc Mandatory	String JSON RPC VERSION - should be "2.0"
method Mandatory	String Method Name - should be "VisaService.GetCompanies"
params Mandatory	Object
api Mandatory	Object
credential Mandatory	String API credential provided by NetXD
signature Mandatory	String Signature of the digitally signed payload
payload Mandatory	Object

cURL

curl --location --globoff '{{URL}}/jsonrpc' \
--header 'Content-Type: application/json' \
--data '{"id":"1","jsonrpc":"2.0","method":"VisaService.GetCompanies","params":{"api":{"credential":"Basic c3VwcG9ydCsxQG5ldHN5cy1pbmMuY29tOjM5ZDYxOGJkNTVmNzQ4ZGQ4ZWY4NWI5NWQxY2RlNDE5","signature":"{{signature}}"},"payload":{}}}'

C#

var options = new RestClientOptions("{{URL}}/jsonrpc")
{
  MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("", Method.Post);
request.AddHeader("Content-Type", "application/json");
var body = @"{
" + "\n" +
@"  ""id"": ""1"",
" + "\n" +
@"  ""jsonrpc"": ""2.0"",
" + "\n" +
@"  ""method"": ""VisaService.GetCompanies"",
" + "\n" +
@"  ""params"": {
" + "\n" +
@"    ""api"": {
" + "\n" +
@"      ""credential"": ""Basic c3VwcG9ydCsxQG5ldHN5cy1pbmMuY29tOjM5ZDYxOGJkNTVmNzQ4ZGQ4ZWY4NWI5NWQxY2RlNDE5"",
" + "\n" +
@"      ""signature"": ""{{signature}}""
" + "\n" +
@"    },
" + "\n" +
@"    ""payload"": {}
" + "\n" +
@"  }
" + "\n" +
@"}";
request.AddStringBody(body, DataFormat.Json);
RestResponse response = await client.ExecuteAsync(request);
Console.WriteLine(response.Content);

Go

package main

import (
  "fmt"
  "strings"
  "net/http"
  "io/ioutil"
)

func main() {

  url := "{{URL}}/jsonrpc"
  method := "POST"

  payload := strings.NewReader(`{`+"
"+`
  "id": "1",`+"
"+`
  "jsonrpc": "2.0",`+"
"+`
  "method": "VisaService.GetCompanies",`+"
"+`
  "params": {`+"
"+`
    "api": {`+"
"+`
      "credential": "Basic c3VwcG9ydCsxQG5ldHN5cy1pbmMuY29tOjM5ZDYxOGJkNTVmNzQ4ZGQ4ZWY4NWI5NWQxY2RlNDE5",`+"
"+`
      "signature": "{{signature}}"`+"
"+`
    },`+"
"+`
    "payload": {}`+"
"+`
  }`+"
"+`
}`)

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, payload)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Content-Type", "application/json")

  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := ioutil.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}

NodeJs

var https = require('follow-redirects').https;
var fs = require('fs');

var options = {
  'method': 'POST',
  'hostname': '{{URL}}',
  'path': '/jsonrpc',
  'headers': {
    'Content-Type': 'application/json'
  },
  'maxRedirects': 20
};

var req = https.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function (chunk) {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });

  res.on("error", function (error) {
    console.error(error);
  });
});

var postData = JSON.stringify({
  "id": "1",
  "jsonrpc": "2.0",
  "method": "VisaService.GetCompanies",
  "params": {
    "api": {
      "credential": "Basic c3VwcG9ydCsxQG5ldHN5cy1pbmMuY29tOjM5ZDYxOGJkNTVmNzQ4ZGQ4ZWY4NWI5NWQxY2RlNDE5",
      "signature": "{{signature}}"
    },
    "payload": {}
  }
});

req.write(postData);

req.end();

Body

{
  "id": "1",
  "jsonrpc": "2.0",
  "method": "VisaService.GetCompanies",
  "params": {
    "api": {
      "credential": "Basic c3VwcG9ydCsxQG5ldHN5cy1pbmMuY29tOjM5ZDYxOGJkNTVmNzQ4ZGQ4ZWY4NWI5NWQxY2RlNDE5",
      "signature": "{{signature}}"
    },
    "payload": {}
  }
}

Response: 201

Response Parameters

Parameter	Description
jsonrpc	String JSON RPC VERSION Example – "2.0"
result	Object
companies	Array
id	String Unique ID of company Example – "65df3e19bc2422fb17c9754f"
createdDate	String Date and time of the company was created Example – "0001-01-01T00:00:00Z"
active	Boolean Whether the company is active or not Example – false
orgName	String Name of the company Example – "LAKE BUENA VISTA"
address1	String Address of the company Example – "12529 State Road 535"
approve	Boolean Whether the company is approved or not Example – false
accountNumber	String Account number of company Example – "15402365478"
enterpriseId	String Unique enterprise ID of the company Example – "V-USA-EUR-10080373-100000001-001"
ceProcessDate	String Date and time of the risk score was processed by context engine Example – "0001-01-01T00:00:00Z"
nsProcessDate	String Date and time of the company was processed for name screening Example – "0001-01-01T00:00:00Z"
approvedDate	String Date and time of the company was approved Example – "0001-01-01T00:00:00Z"
blockedCurrencyList	Array
ALL	String Code of the currency restricted from transaction Example – "ALL"
AMD	String Code of the currency restricted from transaction Example – "AMD"
updatedDate	String Date and time of the company information was last updated Example – "0001-01-01T00:00:00Z"
isOnFlyCorporate	Boolean Determines adding new companies for payment If enabled (True) – allows for addition of new company during payment If disabled (False) – new company can be added only through ‘addCompany' API call Example – false
blockedCountries	Array
ALB	String Code of the blocked country Example – "ALB"
AGO	String Code of the blocked country Example – "AGO"
id	String Unique ID of the request Example – "1"

{
  "jsonrpc": "2.0",
  "result": {
    "companies": [
      {
        "id": "65df3e19bc2422fb17c9754f",
        "createdDate": "0001-01-01T00:00:00Z",
        "active": false,
        "orgName": "LAKE BUENA VISTA",
        "address1": "12529 State Road 535",
        "approve": false,
        "accountNumber": "15402365478",
        "enterpriseId": "V-USA-EUR-10080373-100000001-001",
        "ceProcessDate": "0001-01-01T00:00:00Z",
        "nsProcessDate": "0001-01-01T00:00:00Z",
        "approvedDate": "0001-01-01T00:00:00Z",
        "blockedCurrencyList": [
          "ALL",
          "AMD"
        ],
        "updatedDate": "0001-01-01T00:00:00Z",
        "isOnFlyCorporate": false,
        "blockedCountries": [
          "ALB",
          "AGO"
        ]
      }
    ]
  },
  "id": "1"
}